Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

handle unlimited requested api call and add fallbackIcon props #29560

Closed
wants to merge 8 commits into from
Closed

handle unlimited requested api call and add fallbackIcon props #29560

wants to merge 8 commits into from

Conversation

kaushiktd
Copy link
Contributor

Details

Fixed Issues

$ #26904
PROPOSAL: #26904 (comment)

Tests

I've tested the scenarios with MacOS / Chrome / Safari
Steps to follow:

Open the Expensify URL in web browser and follow below steps:

  1. Open any report and attach an image.
  2. Go to Chrome Dev Tools Network tab and disable cache & offline.
  3. Open another report and reopen the report in which I attached the image.
  4. Check unlimited API requests are displayed in the console tab
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Open the Expensify URL in web browser and follow below steps:

  1. Open any report and attach an image.
  2. Go to Chrome Dev Tools Network tab and disable cache & offline.
  3. Open another report and reopen the report in which I attached the image.
  4. Check unlimited API requests are displayed in the console tab
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari [reloadingimage.webm](https://github.com/Expensify/App/assets/43398804/8b37988c-91ca-4bae-b8b6-5ed0a4146c58) [onlineOfline (1).webm](https://github.com/Expensify/App/assets/43398804/b19629a5-01f7-458d-946b-2853dfc3ebe2)
MacOS: Desktop

@kaushiktd kaushiktd requested a review from a team as a code owner October 13, 2023 13:13
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team October 13, 2023 13:14
@melvin-bot
Copy link

melvin-bot bot commented Oct 13, 2023

@ntdiary Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@kaushiktd
Copy link
Contributor Author

@ntdiary Can you please check now?

return;
}
setLoadState(LoadState.ERRORED);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this line, this delay is just to indicate whether the current image is fetched from the internet or cache, it does not mean the loading failed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is done.

}}
onLoadEnd={() => {
setIsLoading(false);
setLoadState(LoadState.LOADED);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we just need to execute this in the imageLoadedSuccessfully;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is done.

const [isLoading, setIsLoading] = useState(false);

const source = useMemo(() => ({ uri: props.url }), [props.url]);
const {isOffline} = useNetwork();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can replace this line with useNetwork({onReconnect: () => setLoadState(LoadState.LOADING)});

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain which we need to change because if we change only,
const {isOffline} = useNetwork();

this line then it is okay but I don't understand why we need to replace this line,

const source = useMemo(() => ({ uri: props.url }), [props.url]);

it is being used for displaying image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, my mistake, I meant just replacing this line const {isOffline} = useNetwork(); 😅

isAuthTokenRequired={props.isAuthTokenRequired}
resizeMode={Image.resizeMode.cover}
onLoadStart={() => {
if (isLoadedRef.current || isLoading) {
return;
if (loadState === LoadState.LOADED || isOffline) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't need to execute setLoadState(LoadState.INITIAL), just need to return early if loadState === LoadState.LOADED || loadState === LoadState.ERRORED, which will allow us to be compatible with Not Found error.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is done.

@ntdiary
Copy link
Contributor

ntdiary commented Oct 16, 2023

@kaushiktd, sorry, we have time zone differences, so sometimes I can't reply to your messages promptly. 😅

@kaushiktd
Copy link
Contributor Author

@ntdiary no prob! I understand. I have commented the points those are done but one need explanation. Can you please look at that?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 16, 2023

@ntdiary no prob! I understand. I have commented the points those are done but one need explanation. Can you please look at that?

Sure, And there are some image codes can be further optimized, will update later. : )

@kaushiktd
Copy link
Contributor Author

So should I submit PR or wait for it?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 16, 2023

These are the logics I felt needed changes during testing (I'm still doing some other tests):

  1. use <Icon /> component.
  2. add fallbackIcon and iconSize prop, which allows us to change icon and its size.
  3. try to change the background color for fallback image (still in test).

These diffs can help understand what I'm talking about, test.patch.

Please feel free to let me know if you have different thoughts. : )

test.mp4

@kaushiktd
Copy link
Contributor Author

Can you please let me know which path you used to make that video because in my system it is not appearing as you have shown in the video?
Also which background color for fallback image you want me to set?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 17, 2023

Can you please let me know which path you used to make that video because in my system it is not appearing as you have shown in the video? Also which background color for fallback image you want me to set?

Our app has Receipt Scan feature: global green plus button(or attachment plus button) => Request money => Scan tab => upload a image file. If we request money from one person multiple times, they will be combined into one preview message.
As for the specific color value and icon size, we can first support them in the code, then ask the design team again later in this PR. : )

related context:
#26904 (comment)
slack conv

@kaushiktd
Copy link
Contributor Author

Strangely that works perfectly for me!

https://drive.google.com/file/d/1exVP0fhzUg2c0mYpHndVtjytdHASTF9r/view?usp=sharing

@ntdiary
Copy link
Contributor

ntdiary commented Oct 17, 2023

image

The uploaded files can be image/html/pdf/word/svg etc. We should take care of the UI consistent.

@kaushiktd
Copy link
Contributor Author

kaushiktd commented Oct 17, 2023

If you want to make consistent UI, in the line number 39 where we first time set the value to ReceiptGeneric is replaced with the ReceiptPlaceholderImage that sets the UI same for everyone and its type is .png.

It's in SVG as of now.

Also, note that variable 'image' can accept a string. When we pass an .svg file, it becomes a JSX component, which can cause errors. However, converting the .svg file to .png creates limitations – you can't easily modify its size or background color, which are essential functionalities provided by the component. This can lead to inconsistent user interface (UI) issues. So you may want to look at this as well.

I've everything ready for PR if you think we should proceed with PR at this point.

@ntdiary
Copy link
Contributor

ntdiary commented Oct 17, 2023

We should take care of the UI consistent.

I meant the icon size. It would be better if we can make it as close as possible to the size of the main icons in the other images.
image

@kaushiktd
Copy link
Contributor Author

Screenshot 2023-10-18 at 9 51 25 AM
Screenshot 2023-10-18 at 9 51 56 AM
Better now?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 18, 2023

image

a bit strange, it seems like in your pictures, the height of each receipt image is much taller than its width.

@kaushiktd
Copy link
Contributor Author

I set icon size according to the size of icon already present in code and second, I passed iconSize props in both height and width so i don't think the height is taller then the width.

@ntdiary
Copy link
Contributor

ntdiary commented Oct 18, 2023

Hey, @dannymcclain, please feel free to share your thoughts about this #29560 (comment). : )

@kaushiktd
Copy link
Contributor Author

Any update so far?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 21, 2023

Eh, curious, Is the current revision the latest code, synced with your local branch? 🤔

@kaushiktd
Copy link
Contributor Author

kaushiktd commented Oct 21, 2023 via email

@ntdiary
Copy link
Contributor

ntdiary commented Oct 23, 2023

Yeah, pushing the latest code would be better, so I can make suggestions based on them.

@ntdiary
Copy link
Contributor

ntdiary commented Oct 24, 2023

Well, this is the preview on my computer. I'm afraid this effect may not be accepted. 😅
image

@dannymcclain
Copy link
Contributor

Sorry just catching up on this! We'll need to make sure that the offline placeholder is using the right colors—we don't want it to be bright green like the regular placeholders/eReceipts. Here's a reference:

CleanShot 2023-10-24 at 09 08 00@2x

@kaushiktd
Copy link
Contributor Author

Can you check now @dannymcclain ?

@dannymcclain
Copy link
Contributor

@kaushiktd It's looking pretty good! The colors definitely look right. I noticed a couple things I wanted to bring up, but forgive me if they're already known/being worked on elsewhere:

  • In the expense and report, the placeholder looks correct (the icon still looks a little big in the report preview, but it's not bad):

    • CleanShot 2023-10-26 at 09 11 09@2x
    • CleanShot 2023-10-26 at 09 11 17@2x
  • But in the chat, the placeholder is not showing for the request but IS showing for a random image that Jon sent me. Not sure what that's about:

    • CleanShot 2023-10-26 at 09 11 03@2x

cc @Expensify/design

@kaushiktd
Copy link
Contributor Author

I just checked it, and found it working perfectly fine! 😳

https://drive.google.com/file/d/1jgjPZAXTYXQkFKYCj27e7ygOWPLDEo7M/view

@kaushiktd
Copy link
Contributor Author

Any update so far guys?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 30, 2023

  1. Personally, I feel that this placeholder icon is only used for receipt images, and not for generic attachment images.

  2. Precisely, the placeholder icon should only be displayed when image loading fails, because if the image is already cached, it can be displayed normally even offline, and does not need to immediately switch to the placeholder icon

  3. 1:1 report
    image
    image
    Compared to staging version, the height of the request message is obviously shorter. The placeholder icon is too big, I think its size can be referenced to the sizes of other file type images (such as pdf, html etc.).

  4. expense chat
    image
    The placeholder icon looks smaller than normal icons.

Eh, I just noticed how you set the icon size, this is also the reason why the icon sizes are inconsistent when we tested (maybe the browser width and height are different when we opened the app). I don't think we need to do it this way, and suggest you reference the existing code.

// your code
const screenDimensions = Dimensions.get('window');
const iconSize = Math.min(screenDimensions.width, screenDimensions.height) * 0.12; // Adjust the factor (0.2) as needed

// The height varies depending on the number of images we are displaying.
let heightStyle = {};
if (numberOfShownImages === 1) {
heightStyle = StyleUtils.getHeight(variables.reportActionImagesSingleImageHeight);
} else if (numberOfShownImages === 2) {
heightStyle = StyleUtils.getHeight(variables.reportActionImagesDoubleImageHeight);
} else if (numberOfShownImages > 2) {
heightStyle = StyleUtils.getHeight(variables.reportActionImagesMultipleImageHeight);
}

cc @dannymcclain

@kaushiktd
Copy link
Contributor Author

Please check new PR

@ntdiary
Copy link
Contributor

ntdiary commented Nov 3, 2023

Will recheck this over the weekend

@kaushiktd
Copy link
Contributor Author

Any update so far, guys?

Copy link
Contributor

@ntdiary ntdiary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my humble opinion, it would be better to temporarily hold this PR for now. I will ask for the opinions of internal engineer later. 🙂

src/components/ReportActionItem/ReportActionItemImage.js Outdated Show resolved Hide resolved
src/components/ReportActionItem/ReportActionItemImage.js Outdated Show resolved Hide resolved
src/components/ReportActionItem/ReportActionItemImage.js Outdated Show resolved Hide resolved
@kaushiktd
Copy link
Contributor Author

@ntdiary let me know the update when you guys are ready for PR

@ntdiary
Copy link
Contributor

ntdiary commented Nov 15, 2023

@ntdiary let me know the update when you guys are ready for PR

@kaushiktd, not confirmed yet, let's temporarily stop further modifications. 🙂

@kaushiktd
Copy link
Contributor Author

Any update on this, so far?

@ntdiary
Copy link
Contributor

ntdiary commented Dec 12, 2023

Any update on this, so far?

@kaushiktd, thank you for the reminder. I'm still waiting for final confirmation. So far, we want to do two things: 1. fix the infinite loading issue, 2. improve the display of receipt fallback image.
Based on what I've seen in the latest code and this PR, the first part has already been fixed in the react-native-web underlying by another PR. The second part is not very ideal in the current implementation. We may close this issue, and then if needed, create a separate issue for the second part in the future (not urgent). :)

@kaushiktd
Copy link
Contributor Author

Well if we can merge the PR for first issue that is already fixed, will be very helpful as this has been on hold for quite a long time and I am in need of compensation for this job, please!

@kaushiktd kaushiktd closed this by deleting the head repository Jan 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants